<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <title>Swagger-PHP 1.x documentation! &mdash; Swagger-PHP documentation</title>

  <link rel="stylesheet" href="static/pyramid.css" type="text/css" />
  <link rel="stylesheet" href="static/pygments.css" type="text/css" />

  <script type="text/javascript">
    var DOCUMENTATION_OPTIONS = {
      URL_ROOT: './',
      VERSION: '',
      COLLAPSE_INDEX: false,
      FILE_SUFFIX: '.html',
      HAS_SOURCE: true
    };
  </script>
  <script type="text/javascript" src="static/jquery.js"></script>
  <script type="text/javascript" src="static/underscore.js"></script>
  <script type="text/javascript" src="static/doctools.js"></script>
  <link rel="top" title="Swagger-PHP  documentation" href="#" />
  <link rel="next" title="Installation" href="installation.html" />
  <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen"
    charset="utf-8" />
  <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin"
    type="text/css" media="screen" charset="utf-8" />
  <!--[if lte IE 6]>
<link rel="stylesheet" href="static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->

</head>

<body>

  <div class="related">
    <h3>Navigation</h3>
    <ul>
      <li class="right" style="margin-right: 10px">
        <a href="installation.html" title="Installation" accesskey="N">next</a>
      </li>
      <li>
        <a href="#">Swagger-PHP documentation</a> &raquo;</li>
    </ul>
  </div>

  <div class="document">
    <div class="documentwrapper">
      <div class="bodywrapper">
        <div class="body">

          <div class="section" id="welcome-to-swagger-php-s-documentation">
            <h1>Welcome to Swagger-PHP&#8217;s documentation!
              <a class="headerlink" href="#welcome-to-swagger-php-s-documentation" title="Permalink to this headline">¶</a>
            </h1>
            <div class="admonition note">
              <p class="first admonition-title">Note</p>
              <p class="last">This is the documentation for (older / unsupported) swagger-php v1.x
                <br>Go to the
                <a href="../">swagger-php v3.x documentation</a>
              </p>
            </div>
            <p>Contents:</p>
            <div class="toctree-wrapper compound">
              <ul>
                <li class="toctree-l1">
                  <a class="reference internal" href="installation.html">Installation</a>
                  <ul>
                    <li class="toctree-l2">
                      <a class="reference internal" href="installation.html#via-composer-recommended">Via Composer (Recommended)</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="installation.html#via-phar">Via Phar</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="installation.html#manual-unsupported">Manual (Unsupported)</a>
                    </li>
                  </ul>
                </li>
                <li class="toctree-l1">
                  <a class="reference internal" href="using_swagger.html">Using Swagger-PHP</a>
                  <ul>
                    <li class="toctree-l2">
                      <a class="reference internal" href="using_swagger.html#via-command-line">Via Command Line</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="using_swagger.html#via-php">Via PHP</a>
                    </li>
                  </ul>
                </li>
                <li class="toctree-l1">
                  <a class="reference internal" href="annotations.html">Annotations</a>
                  <ul>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#annotation-hierarchy">Annotation Hierarchy</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#resource">Resource</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#api">Api</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#operation">Operation</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#responsemessage">ResponseMessage</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#parameter">Parameter</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#model">Model</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#property">Property</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="annotations.html#items">Items</a>
                    </li>
                  </ul>
                </li>
                <li class="toctree-l1">
                  <a class="reference internal" href="partials.html">Partials</a>
                  <ul>
                    <li class="toctree-l2">
                      <a class="reference internal" href="partials.html#defining-a-partial">Defining a partial</a>
                    </li>
                    <li class="toctree-l2">
                      <a class="reference internal" href="partials.html#using-a-partial">Using a partial</a>
                    </li>
                  </ul>
                </li>
              </ul>
            </div>
          </div>
          <div class="section" id="about-swagger-php">
            <h1>About Swagger-PHP
              <a class="headerlink" href="#about-swagger-php" title="Permalink to this headline">¶</a>
            </h1>
            <p>Swagger-PHP is a PHP annotations library for generating
              <a class="reference external" href="http://swagger.wordnik.com">Swagger</a> compatible JSON documentation for your API. The resulting JSON documentation may then be utilized
              for internal and external user friendly documentation, API portal sandbox with
              <a class="reference external" href="https://github.com/wordnik/swagger-ui">Swagger UI</a> as well as client code generation with the
              <a class="reference external" href="https://github.com/wordnik/swagger-codegen">Swagger Code Generation tooling</a>.</p>
          </div>


        </div>
      </div>
    </div>
    <div class="sphinxsidebar">
      <div class="sphinxsidebarwrapper">
        <h3>
          <a href="#">Table Of Contents</a>
        </h3>
        <ul>
          <li>
            <a class="reference internal" href="#">Welcome to Swagger-PHP&#8217;s documentation!</a>
          </li>
          <li>
            <a class="reference internal" href="#about-swagger-php">About Swagger-PHP</a>
          </li>
        </ul>

        <h4>Next topic</h4>
        <p class="topless">
          <a href="installation.html" title="next chapter">Installation</a>
        </p>
        <div id="searchbox" style="display: none">
          <h3>Quick search</h3>
          <form class="search" action="search.html" method="get">
            <input type="text" name="q" />
            <input type="submit" value="Go" />
            <input type="hidden" name="check_keywords" value="yes" />
            <input type="hidden" name="area" value="default" />
          </form>
          <p class="searchtip" style="font-size: 90%">
            Enter search terms or a module, class or function name.
          </p>
        </div>
        <script type="text/javascript">$('#searchbox').show(0);</script>
      </div>
    </div>
    <div class="clearer"></div>
  </div>
  <div class="related">
    <h3>Navigation</h3>
    <ul>
      <li class="right" style="margin-right: 10px">
        <a href="installation.html" title="Installation">next</a>
      </li>
      <li>
        <a href="#">Swagger-PHP documentation</a> &raquo;</li>
    </ul>
  </div>
  <div class="footer">
    &copy; Copyright 2014, Robert Allen &amp; Bob Fanger. Created using
    <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
  </div>
</body>

</html>